<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: Function.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.parse.func;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.annotation.Documented;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.lang.annotation.ElementType;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.lang.annotation.Retention;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.lang.annotation.RetentionPolicy;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.lang.annotation.Target;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>/**<a name="line.16"></a>
<span class="sourceLineNo">017</span> * Java annotation for classes that define custom {@link org.jsimpledb.parse.ParseContext} functions.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> * &lt;p&gt;<a name="line.19"></a>
<span class="sourceLineNo">020</span> * Annotated classes must extend {@link AbstractFunction}<a name="line.20"></a>
<span class="sourceLineNo">021</span> * and have a public constructor taking either zero parameters or a single {@link org.jsimpledb.parse.ParseSession} parameter.<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;/p&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * @see AbstractFunction<a name="line.24"></a>
<span class="sourceLineNo">025</span> * @see SimpleFunction<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.27"></a>
<span class="sourceLineNo">028</span>@Target(ElementType.TYPE)<a name="line.28"></a>
<span class="sourceLineNo">029</span>@Documented<a name="line.29"></a>
<span class="sourceLineNo">030</span>public @interface Function {<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * Determine whether the annotated {@link org.jsimpledb.parse.func.AbstractFunction} works properly in Core API mode,<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * i.e., when the there are no {@link org.jsimpledb.annotation.JSimpleClass &amp;#64;JSimpleClass}-annotated Java model<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * classes defined and the core {@link org.jsimpledb.core.Database} API is used.<a name="line.35"></a>
<span class="sourceLineNo">036</span>     *<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * @return true if the function works in core API mode<a name="line.37"></a>
<span class="sourceLineNo">038</span>     */<a name="line.38"></a>
<span class="sourceLineNo">039</span>    boolean worksInCoreAPIMode() default true;<a name="line.39"></a>
<span class="sourceLineNo">040</span>}<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>




























































</pre>
</div>
</body>
</html>
